groundsdk 7.7.2 API/com.parrot.drone.groundsdk.device.pilotingitf.animation/Spiral

Spiral

interface Spiral : Animation

Spiral animation interface.

This animation instructs the drone to circle around the target, possibly in a spiral shape and possibly also while flying vertically (up or down). The target in question depends on the currently active piloting interface.

Types

Link copied to clipboard
class Config : Animation.Config
Spiral animation configuration class.

Functions

Link copied to clipboard
@NonNull
abstract fun getMode(): Animation.Mode
Retrieves currently applied animation execution mode.
Link copied to clipboard
@IntRange(from = 0, to = 100)
abstract fun getProgress(): Int
Retrieves current animation progress.
Link copied to clipboard
abstract fun getRadiusVariation(): Double
Retrieves currently applied animation radius variation.
Link copied to clipboard
abstract fun getRevolutionAmount(): Double
Retrieves currently applied animation revolution amount.
Link copied to clipboard
@FloatRange(from = 0)
abstract fun getSpeed(): Double
Retrieves currently applied animation speed.
Link copied to clipboard
@NonNull
abstract fun getStatus(): Animation.Status
Retrieves current animation execution status.
Link copied to clipboard
@NonNull
abstract fun getType(): Animation.Type
Retrieves the animation type.
Link copied to clipboard
abstract fun getVerticalDistance(): Double
Retrieves currently applied animation vertical distance.
Link copied to clipboard
abstract fun matchesConfig(@NonNull config: Animation.Config): Boolean
Tells whether the animation matches some configuration.